provider Snapshots GET
/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/preprod/snapshots/status-check-rules/ @utdk/sentry
/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/preprod/snapshots/status-check-rules/ Retrieve Snapshot status check rules for a project
Retrieve the current Snapshot status check rules configured for a project.
Use this endpoint when external CI needs to evaluate the same Snapshot
change-type rules that Sentry uses. The endpoint returns the current
project configuration, not a historical snapshot from when a build was
processed.
The response includes whether status check enforcement is enabled and the
Snapshot change types that fail the status check.
This endpoint requires a bearer token with `project:read` access. Project
distribution tokens are not supported.
Response notes:
- `enabled: false` means status-check enforcement is disabled for the project.
- `rules` contains one boolean per Snapshot change type.
- `failOnAdded`, `failOnRemoved`, `failOnChanged`, and `failOnRenamed`
indicate which unapproved change types fail the status check.
- organization_id_or_slug path required
- The ID or slug of the organization the resource belongs to.
- string
- project_id_or_slug path required
- The ID or slug of the project the resource belongs to.
- string
Try it
Authentication
Configure credentials for API Reference
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import sentry from '@utdk/sentry';
await sentry.retrieveSnapshotStatusCheckRulesForAProject()